//
// Encog(tm) Core v3.3 - .Net Version
// http://www.heatonresearch.com/encog/
//
// Copyright 2008-2014 Heaton Research, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//   
// For more information on Heaton Research copyrights, licenses 
// and trademarks visit:
// http://www.heatonresearch.com/copyright
//
namespace Encog.Neural.Freeform
{
    /// <summary>
    /// Some training methods require that temp data be stored during the training
    /// process.
    /// </summary>
    public interface ITempTrainingData
    {
        /// <summary>
        /// Add to the specified temp value.
        /// </summary>
        /// <param name="i">The index.</param>
        /// <param name="value">The value to add.</param>
        void AddTempTraining(int i, double value);

        /// <summary>
        /// Allocate the specified length of temp training.
        /// </summary>
        /// <param name="l">The length.</param>
        void AllocateTempTraining(int l);

        /// <summary>
        /// Clear the temp training.
        /// </summary>
        void ClearTempTraining();

        /// <summary>
        /// Get the specified temp training.
        /// </summary>
        /// <param name="index">The index.</param>
        /// <returns>The temp training value.</returns>
        double GetTempTraining(int index);

        /// <summary>
        /// Set a temp training value.
        /// </summary>
        /// <param name="index">The index.</param>
        /// <param name="value">The value.</param>
        void SetTempTraining(int index, double value);
    }
}
